.TH std::inout_ptr_t::operatorPointer*, 3 "2024.06.10" "http://cppreference.com" "C++ Standard Libary"
.SH NAME
std::inout_ptr_t::operatorPointer*, \- std::inout_ptr_t::operatorPointer*,

.SH Synopsis

   operator Pointer*() const noexcept; \fB(1)\fP (since C++23)
   operator void**() const noexcept;   \fB(2)\fP (since C++23)

   Exposes the address of a Pointer or void* object to a foreign function which will
   generally release the ownership represented by its value and then re-initialize it.

   1) Converts *this to the address of stored Pointer object.
   2) Converts *this to the address of a void* object. This conversion function
   participates in overload resolution only if Pointer is not same as void*, and the
   program is ill-formed if Pointer is not a pointer type.
   The initial value of the void* object is equal the value of the stored Pointer
   object converted to void*, and any modification to it affects the Pointer value used
   in the destructor. Accessing the void* object outside the lifetime of *this has
   undefined behavior.

   Once one of these two conversion functions has been called on an inout_ptr_t object,
   the other shall not be called on it, otherwise, the behavior is undefined.

.SH Parameters

   \fI(none)\fP

.SH Return value

   1) The address of stored Pointer object.
   2) The address of the void* object that satisfies aforementioned requirements.

.SH Notes

   If the object pointed by the return value has not been rewritten, it is equal to the
   value held by adapted Smart object before construction.

   On common implementations, the object representation of every Pointer that is a
   pointer type is compatible with that of void*, and therefore these implementations
   typically store the void* object within the storage for the Pointer object, no
   additional storage needed:

     * If the implementation enables type-based alias analysis (which relies on the
       strict aliasing rule), a properly aligned std::byte[sizeof(void*)] member
       subobject may be used, and both conversion functions return the address of
       objects implicitly created within the array.
     * Otherwise, a Pointer member subobject may be used for both conversion functions,
       and \fB(2)\fP may directly returns its address reinterpret_cast to void**.

   If Pointer is a pointer type whose object representation is incompatible with that
   of void*, an additional bool flag may be needed for recording whether \fB(1)\fP (or \fB(2)\fP)
   has been called.

.SH Example

    This section is incomplete
    Reason: no example

.SH Category:
     * Todo no example
